All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.JTabbedPane 

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----com.sun.java.swing.JComponent
                           |
                           +----com.sun.java.swing.JTabbedPane
public class JTabbedPane
extends JComponent
implements Serializable, Accessible, SwingConstants
A component which lets the user switch between a group of components by clicking on a tab with a given title and/or icon.

Tabs/components are added to a TabbedPane object by using the addTab and insertTab methods. A tab is represented by an index corresponding to the position it was added in, where the first tab has an index equal to 0 and the last tab has an index equal to the tab count minus 1.

The TabbedPane uses a SingleSelectionModel to represent the set of tab indeces and the currently selected index. If the tab count is greater than 0, then there will always be a selected index, which by default will be initialized to the first tab. If the tab count is 0, then the selected index will be -1.

See How to Use Tabbed Panes in The Java Tutorial for further documentation.

For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions, see the JTabbedPane key assignments.

Warning: serialized objects of this class will not be compatible with future swing releases. The current serialization support is appropriate for short term storage or RMI between Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

See Also:
SingleSelectionModel

Variable Index

o changeEvent
Only one ChangeEvent is needed per TabPane instance since the event's only (read-only) state is the source property.
o changeListener
The changeListener is the listener we add to the model.
o model
The default selection model
o tabPlacement
Where the tabs are placed.

Constructor Index

o JTabbedPane()
Creates an empty TabbedPane.
o JTabbedPane(int)
Creates an empty TabbedPane with the specified tab placement of either: TOP, BOTTOM, LEFT, or RIGHT.

Method Index

o add(Component)
Adds a component with a tab title defaulting to the name of the component.
o add(Component, int)
Adds a component at the specified tab index with a tab title defaulting to the name of the component.
o add(Component, Object)
Adds a component to the tabbed pane.
o add(Component, Object, int)
Adds a component at the specified tab index.
o add(String, Component)
Adds a component with the specified tab title.
o addChangeListener(ChangeListener)
Adds a ChangeListener to this tabbedpane.
o addTab(String, Component)
Adds a component represented by a title and no icon.
o addTab(String, Icon, Component)
Adds a component represented by a title and/or icon, either of which can be null.
o addTab(String, Icon, Component, String)
Adds a component and tip represented by a title and/or icon, either of which can be null.
o createChangeListener()
Subclasses that want to handle ChangeEvents differently can override this to return a subclass of ModelListener or another ChangeListener implementation.
o fireStateChanged()
Send a ChangeEvent, whose source is this tabbedpane, to each listener.
o getAccessibleContext()
Get the AccessibleContext associated with this JComponent
o getBackgroundAt(int)
Returns the tab background color at index.
o getBoundsAt(int)
Returns the tab bounds at index.
o getComponentAt(int)
Returns the component at index.
o getDisabledIconAt(int)
Returns the tab disabled icon at index.
o getForegroundAt(int)
Returns the tab foreground color at index.
o getIconAt(int)
Returns the tab icon at index.
o getModel()
Returns the model associated with this tabbedpane.
o getSelectedComponent()
Returns the currently selected component for this tabbedpane.
o getSelectedIndex()
Returns the currently selected index for this tabbedpane.
o getTabCount()
Returns the number of tabs in this tabbedpane.
o getTabPlacement()
Returns the placement of the tabs for this tabbedpane.
o getTabRunCount()
Returns the number of tab runs currently used to display the tabs.
o getTitleAt(int)
Returns the tab title at index.
o getToolTipText(MouseEvent)
Returns the tooltip text for the component determined by the mouse event location.
o getUI()
Returns the UI object which implements the L&F for this component.
o getUIClassID()
Returns the name of the UI class that implements the L&F for this component.
o indexOfComponent(Component)
Returns the index of the tab for the specified component.
o indexOfTab(Icon)
Returns the first tab index with a given icon.
o indexOfTab(String)
Returns the first tab index with a given title, Returns -1 if no tab has this title.
o insertTab(String, Icon, Component, String, int)
Inserts a component, at index, represented by a title and/or icon, either of which may be null.
o isEnabledAt(int)
Returns whether or not the tab at index is currently enabled.
o remove(Component)
Removes the tab which corresponds to the specified component.
o removeAll()
Removes all the tabs from the tabbedpane.
o removeChangeListener(ChangeListener)
Removes a ChangeListener from this tabbedpane.
o removeTabAt(int)
Removes the tab at index.
o setBackgroundAt(int, Color)
Sets the background color at index to background which can be null, in which case the tab's background color will default to the background color of the tabbedpane.
o setComponentAt(int, Component)
Sets the component at index to component.
o setDisabledIconAt(int, Icon)
Sets the disabled icon at index to icon which can be null.
o setEnabledAt(int, boolean)
Sets whether or not the tab at index is enabled.
o setForegroundAt(int, Color)
Sets the foreground color at index to foreground which can be null, in which case the tab's foreground color will default to the foreground color of this tabbedpane.
o setIconAt(int, Icon)
Sets the icon at index to icon which can be null.
o setModel(SingleSelectionModel)
Sets the model to be used with this tabbedpane.
o setSelectedComponent(Component)
Sets the selected component for this tabbedpane.
o setSelectedIndex(int)
Sets the selected index for this tabbedpane.
o setTabPlacement(int)
Sets the tab placement for this tabbedpane.
o setTitleAt(int, String)
Sets the title at index to title which can be null.
o setUI(TabbedPaneUI)
Sets the UI object which implements the L&F for this component.
o updateUI()
Notification from the UIManager that the L&F has changed.

Variables

o tabPlacement 
 protected int tabPlacement
Where the tabs are placed.

See Also:
setTabPlacement
o model 
 protected SingleSelectionModel model
The default selection model

o changeListener 
 protected ChangeListener changeListener
The changeListener is the listener we add to the model.

o changeEvent 
 protected transient ChangeEvent changeEvent
Only one ChangeEvent is needed per TabPane instance since the event's only (read-only) state is the source property. The source of events generated here is always "this".

Constructors

o JTabbedPane 
 public JTabbedPane()
Creates an empty TabbedPane.

See Also:
addTab
o JTabbedPane 
 public JTabbedPane(int tabPlacement)
Creates an empty TabbedPane with the specified tab placement of either: TOP, BOTTOM, LEFT, or RIGHT.

Parameters:
tabPlacement - the placement for the tabs relative to the content
See Also:
addTab

Methods

o getUI 
 public TabbedPaneUI getUI()
Returns the UI object which implements the L&F for this component.

See Also:
setUI
o setUI 
 public void setUI(TabbedPaneUI ui)
Sets the UI object which implements the L&F for this component.

Parameters:
ui - the new UI object
See Also:
getUI
o updateUI 
 public void updateUI()
Notification from the UIManager that the L&F has changed. Called to replace the UI with the latest version from the default UIFactory.

Overrides:
updateUI in class JComponent
See Also:
updateUI
o getUIClassID 
 public String getUIClassID()
Returns the name of the UI class that implements the L&F for this component.

Returns:
"TabbedPaneUI"
Overrides:
getUIClassID in class JComponent
See Also:
getUIClassID, getUI
o createChangeListener 
 protected ChangeListener createChangeListener()
Subclasses that want to handle ChangeEvents differently can override this to return a subclass of ModelListener or another ChangeListener implementation.

See Also:
fireStateChanged
o addChangeListener 
 public void addChangeListener(ChangeListener l)
Adds a ChangeListener to this tabbedpane.

Parameters:
l - the ChangeListener to add
See Also:
fireStateChanged, removeChangeListener
o removeChangeListener 
 public void removeChangeListener(ChangeListener l)
Removes a ChangeListener from this tabbedpane.

Parameters:
l - the ChangeListener to remove
See Also:
fireStateChanged, addChangeListener
o fireStateChanged 
 protected void fireStateChanged()
Send a ChangeEvent, whose source is this tabbedpane, to each listener. This method method is called each time a ChangeEvent is received from the model.

See Also:
addChangeListener, EventListenerList
o getModel 
 public SingleSelectionModel getModel()
Returns the model associated with this tabbedpane.

See Also:
setModel
o setModel 
 public void setModel(SingleSelectionModel model)
Sets the model to be used with this tabbedpane.

Parameters:
model - the model to be used
See Also:
getModel
o getTabPlacement 
 public int getTabPlacement()
Returns the placement of the tabs for this tabbedpane.

See Also:
setTabPlacement
o setTabPlacement 
 public void setTabPlacement(int tabPlacement)
Sets the tab placement for this tabbedpane. Possible values are:
  • SwingConstants.TOP
  • SwingConstants.BOTTOM
  • SwingConstants.LEFT
  • SwingConstants.RIGHT
The default value, if not set, is TOP.

Parameters:
tabPlacement - the placement for the tabs relative to the content
o getSelectedIndex 
 public int getSelectedIndex()
Returns the currently selected index for this tabbedpane. Returns -1 if there is no currently selected tab.

Returns:
the index of the selected tab
See Also:
setSelectedIndex
o setSelectedIndex 
 public void setSelectedIndex(int index)
Sets the selected index for this tabbedpane.

See Also:
getSelectedIndex, setSelectedIndex
o getSelectedComponent 
 public Component getSelectedComponent()
Returns the currently selected component for this tabbedpane. Returns null if there is no currently selected tab.

Returns:
the component corresponding to the selected tab
See Also:
setSelectedComponent
o setSelectedComponent 
 public void setSelectedComponent(Component c)
Sets the selected component for this tabbedpane. This will automatically set the selectedIndex to the index corresponding to the specified component.

See Also:
getSelectedComponent
o insertTab 
 public void insertTab(String title,
                       Icon icon,
                       Component component,
                       String tip,
                       int index)
Inserts a component, at index, represented by a title and/or icon, either of which may be null. Uses java.util.Vector internally, see insertElementAt() for details of insertion conventions.

Parameters:
title - the title to be displayed in this tab
icon - the icon to be displayed in this tab
component - The component to be displayed when this tab is clicked.
tip - the tooltip to be displayed for this tab
index - the position to insert this new tab
See Also:
addTab, removeTabAt
o addTab 
 public void addTab(String title,
                    Icon icon,
                    Component component,
                    String tip)
Adds a component and tip represented by a title and/or icon, either of which can be null. Cover method for insertTab().

Parameters:
title - the title to be displayed in this tab
icon - the icon to be displayed in this tab
component - The component to be displayed when this tab is clicked.
tip - the tooltip to be displayed for this tab
See Also:
insertTab, removeTabAt
o addTab 
 public void addTab(String title,
                    Icon icon,
                    Component component)
Adds a component represented by a title and/or icon, either of which can be null. Cover method for insertTab().

Parameters:
title - the title to be displayed in this tab
icon - the icon to be displayed in this tab
component - The component to be displayed when this tab is clicked.
See Also:
insertTab, removeTabAt
o addTab 
 public void addTab(String title,
                    Component component)
Adds a component represented by a title and no icon. Cover method for insertTab().

Parameters:
title - the title to be displayed in this tab
component - The component to be displayed when this tab is clicked.
See Also:
insertTab, removeTabAt
o add 
 public Component add(Component component)
Adds a component with a tab title defaulting to the name of the component. Cover method for insertTab().

Parameters:
component - The component to be displayed when this tab is clicked.
Overrides:
add in class Container
See Also:
insertTab, removeTabAt
o add 
 public Component add(String title,
                      Component component)
Adds a component with the specified tab title. Cover method for insertTab().

Parameters:
title - the title to be displayed in this tab
component - The component to be displayed when this tab is clicked.
Overrides:
add in class Container
See Also:
insertTab, removeTabAt
o add 
 public Component add(Component component,
                      int index)
Adds a component at the specified tab index with a tab title defaulting to the name of the component. Cover method for insertTab().

Parameters:
component - The component to be displayed when this tab is clicked.
index - the position to insert this new tab
Overrides:
add in class Container
See Also:
insertTab, removeTabAt
o add 
 public void add(Component component,
                 Object constraints)
Adds a component to the tabbed pane. If constraints is a String or an Icon, it will be used for the tab title, otherwise the component's name will be used as the tab title. Cover method for insertTab().

Parameters:
component - The component to be displayed when this tab is clicked.
Overrides:
add in class Container
See Also:
insertTab, removeTabAt
o add 
 public void add(Component component,
                 Object constraints,
                 int index)
Adds a component at the specified tab index. If constraints is a String or an Icon, it will be used for the tab title, otherwise the component's name will be used as the tab title. Cover method for insertTab().

Parameters:
component - The component to be displayed when this tab is clicked.
index - the position to insert this new tab
Overrides:
add in class Container
See Also:
insertTab, removeTabAt
o removeTabAt 
 public void removeTabAt(int index)
Removes the tab at index.

Parameters:
index - the index of the tab to be removed
See Also:
addTab, insertTab
o remove 
 public void remove(Component component)
Removes the tab which corresponds to the specified component.

Parameters:
component - the component to remove from the tabbedpane
Overrides:
remove in class Container
See Also:
addTab, removeTabAt
o removeAll 
 public void removeAll()
Removes all the tabs from the tabbedpane.

Overrides:
removeAll in class Container
See Also:
addTab, removeTabAt
o getTabCount 
 public int getTabCount()
Returns the number of tabs in this tabbedpane.

Returns:
an int specifying the number of tabbed pages
o getTabRunCount 
 public int getTabRunCount()
Returns the number of tab runs currently used to display the tabs.

Returns:
an int giving the number of rows if the tabPlacement is TOP or BOTTOM and the number of columns if tabPlacement is LEFT or RIGHT, or 0 if there is no UI set on this tabbedpane
o getTitleAt 
 public String getTitleAt(int index)
Returns the tab title at index.

See Also:
setTitleAt
o getIconAt 
 public Icon getIconAt(int index)
Returns the tab icon at index.

See Also:
setIconAt
o getDisabledIconAt 
 public Icon getDisabledIconAt(int index)
Returns the tab disabled icon at index.

See Also:
setDisabledIconAt
o getBackgroundAt 
 public Color getBackgroundAt(int index)
Returns the tab background color at index.

See Also:
setBackgroundAt
o getForegroundAt 
 public Color getForegroundAt(int index)
Returns the tab foreground color at index.

See Also:
setForegroundAt
o isEnabledAt 
 public boolean isEnabledAt(int index)
Returns whether or not the tab at index is currently enabled.

See Also:
setEnabledAt
o getComponentAt 
 public Component getComponentAt(int index)
Returns the component at index.

See Also:
setComponentAt
o getBoundsAt 
 public Rectangle getBoundsAt(int index)
Returns the tab bounds at index. If there is no UI set on this tabbedpane, then returns null.

o setTitleAt 
 public void setTitleAt(int index,
                        String title)
Sets the title at index to title which can be null. An internal exception is raised if there is no tab at that index.

Parameters:
index - the tab index where the title should be set
title - the title to be displayed in the tab
See Also:
getTitleAt
o setIconAt 
 public void setIconAt(int index,
                       Icon icon)
Sets the icon at index to icon which can be null. An internal exception is raised if there is no tab at that index.

Parameters:
index - the tab index where the icon should be set
icon - the icon to be displayed in the tab
See Also:
getIconAt
o setDisabledIconAt 
 public void setDisabledIconAt(int index,
                               Icon disabledIcon)
Sets the disabled icon at index to icon which can be null. An internal exception is raised if there is no tab at that index.

Parameters:
index - the tab index where the disabled icon should be set
icon - the icon to be displayed in the tab when disabled
See Also:
getDisabledIconAt
o setBackgroundAt 
 public void setBackgroundAt(int index,
                             Color background)
Sets the background color at index to background which can be null, in which case the tab's background color will default to the background color of the tabbedpane. An internal exception is raised if there is no tab at that index.

Parameters:
index - the tab index where the background should be set
background - the color to be displayed in the tab's background
See Also:
getBackgroundAt
o setForegroundAt 
 public void setForegroundAt(int index,
                             Color foreground)
Sets the foreground color at index to foreground which can be null, in which case the tab's foreground color will default to the foreground color of this tabbedpane. An internal exception is raised if there is no tab at that index.

Parameters:
index - the tab index where the foreground should be set
foreground - the color to be displayed as the tab's foreground
See Also:
getForegroundAt
o setEnabledAt 
 public void setEnabledAt(int index,
                          boolean enabled)
Sets whether or not the tab at index is enabled. An internal exception is raised if there is no tab at that index.

Parameters:
index - the tab index which should be enabled/disabled
enabled - whether or not the tab should be enabled
See Also:
isEnabledAt
o setComponentAt 
 public void setComponentAt(int index,
                            Component component)
Sets the component at index to component. An internal exception is raised if there is no tab at that index.

Parameters:
index - the tab index where this component is being placed
component - the component for the tab
See Also:
getComponentAt
o indexOfTab 
 public int indexOfTab(String title)
Returns the first tab index with a given title, Returns -1 if no tab has this title.

Parameters:
title - the title for the tab
o indexOfTab 
 public int indexOfTab(Icon icon)
Returns the first tab index with a given icon. Returns -1 if no tab has this icon.

Parameters:
icon - the icon for the tab
o indexOfComponent 
 public int indexOfComponent(Component component)
Returns the index of the tab for the specified component. Returns -1 if there is no tab for this component.

Parameters:
component - the component for the tab
o getToolTipText 
 public String getToolTipText(MouseEvent event)
Returns the tooltip text for the component determined by the mouse event location.

Parameters:
event - the MouseEvent that tells where the cursor is lingering
Returns:
the String with the tooltip text
Overrides:
getToolTipText in class JComponent
o getAccessibleContext 
 public AccessibleContext getAccessibleContext()
Get the AccessibleContext associated with this JComponent

Returns:
the AccessibleContext of this JComponent
Overrides:
getAccessibleContext in class JComponent 
All Packages  Class Hierarchy  This Package  Previous  Next  Index